Skip to main content

FTP Connector

Provides access to files and folders on an FTP server. FTP Connector operations manage file transfers by using File Transfer Protocol (FTP). The Connector’s main features include:

  1. The ability to read files or fully list directory contents on demand.

  2. Support for common FTP operations such as creating directories and copying, moving, renaming, and deleting files.

  3. Support for locking files.

  4. File matching functionality.

A design that is consistent with the File and FTP Connectors.

The same set of operations is available using these two Connectors, and they behave similarly.

Configuring FTP Connector

Follow these steps to set up and test a connection to your FTP by creating a reusable global variable for the FTP Connector to reference.

Drag and drop the FTP Connector

FTP Connector

Configuring FTP Connector

left click on connector, you can define the FTP Connector configration

Read FTP Connector

Read FTP Connector
FieldsDescriptionExample
TypeRead/WriteRead
Datasource NameDatasource Name which is configured in connections properties Please refer the link for instructions on creating the datasource nameftpcall
File NameName of the file to be processedContacts
File TypeFormat of FileCSV
OutPutOutputRest_output
OperationOperation of the fileMove
DestinationLocal destination file path/app/Schemas/Customers

Write FTP Connector

Write FTP Connector
FieldsDescriptionExample
TypeRead/WriteWrite
Datasource NameDatasource Name which is configured in connections properties Please refer the link for instructions on creating the datasource nameftpcall
File NameProcessed FileContacts
File TypeFormat of FileCSV
InputInputREQUEST_PAYLOAD
Append/OverWriteSelect "append" to add the request or choose "overwrite" to modify the requestAppend

Retry

Retry is flag passed on connector nodes, like FTP, to allow the step to be retryable if any exception occurs. It has 2 configurable properties.

  1. maxRetryAttempts: The max number of retries if any exception occurs. max attempts are 3.
  2. retryIntervalMillis: The max interval between retries. Max range is 6000ms.

Enable retry by cliking on the Enable Retry radio button at the top of the configuration pannel.

PAYLOAD transformer